@react-types/shared

What is @react-types/shared?

@react-types/shared is a TypeScript utility library that provides shared types and interfaces for React components. It is part of the React Spectrum collection of libraries, which are designed to work together to build accessible, performant, and robust user interfaces.

What are @react-types/shared's main functionalities?

DOMProps

The DOMProps interface defines common properties that can be applied to any DOM element, such as id, className, and style.

interface DOMProps {
  id?: string;
  className?: string;
  style?: React.CSSProperties;
}

AriaLabelingProps

The AriaLabelingProps interface defines properties for ARIA labeling, which are used to improve accessibility by providing additional context to screen readers.

interface AriaLabelingProps {
  'aria-label'?: string;
  'aria-labelledby'?: string;
  'aria-describedby'?: string;
}

StyleProps

The StyleProps interface defines common style properties that can be applied to components, such as margin, padding, and border.

interface StyleProps {
  margin?: string | number;
  padding?: string | number;
  border?: string;
}

Other packages similar to @react-types/shared

prop-types

PropTypes is a library for runtime type checking of React props. It provides a way to validate the types of props passed to a component, ensuring they match the expected types. Unlike @react-types/shared, which is focused on TypeScript type definitions, PropTypes is used for runtime validation in JavaScript.

typescript

TypeScript is a superset of JavaScript that adds static type definitions. It allows developers to define types for variables, function parameters, and return values, providing compile-time type checking. While @react-types/shared provides specific types for React components, TypeScript offers a broader range of type definitions and type-checking capabilities.

react-aria

React Aria is a library that provides accessible UI primitives for React applications. It includes hooks and components for managing focus, keyboard interactions, and ARIA attributes. While @react-types/shared provides type definitions, React Aria focuses on implementing accessible behaviors and interactions.

README

@react-types/shared

This package is part of react-spectrum. See the repo for more details.